home *** CD-ROM | disk | FTP | other *** search
/ Merciful 2 / Merciful - Disc 2.iso / software / v / varkcliutils11.dms / varkcliutils11.adf / VARK / YSsim.Doc / YSsim.Doc
Text File  |  1996-02-04  |  6KB  |  120 lines
  1.                         YOUR SINCLAIR SIMULATOR v1.0
  2.                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.                      © 1995. This program is FREEWARE.
  4.  
  5.                               ABOUT THE AUTHOR
  6.                               ~~~~~~~~~~~~~~~~
  7. Well,  I'm a second year Computer Science student at Heriot-Watt University,
  8. and YSsim is the first piece of software I've released on a wide scale.  I'd
  9. really  love  to get some responses to YSsim via electronic mail. My address
  10. is ceeag1@cee.hw.ac.uk and you can be certain that I'll  give  you  a  reply
  11. (for what it's worth).
  12.  
  13. If  you actually do want to find out more about me or my interests or any of
  14. my other programming projects, have a look  at  my  World  Wide  Web  pages,
  15. which can be found at http://www.cee.hw.ac.uk/~ceeag1/
  16.  
  17.                                  BACKGROUND
  18.                                  ~~~~~~~~~~
  19. Having grown up and begun to use computers in the late 1980s, the era of the
  20. ZX  Spectrum,  I fell under the influence of the witty and off-beat computer
  21. magazine, Your Sinclair. As well as being the definitive  Spectrum  magazine
  22. (anybody  who disagrees will be beaten up with the aid of a very large plank
  23. of  wood  sporting  some rather pointy rusty nails at the business end), the
  24. mid-to-late-80's Your Sinclairs gave birth to some of my all-time  favourite
  25. linguistic  expressions.  You can't beat a strategically-placed wahay, oo-er
  26. or wagga wagga to lend that inimitable YS quality to a piece of writing.
  27.  
  28. The  Your  Sinclair  Simulator  gives  you  the power to use these wonderful
  29. words at your fingertips. With the touch of a few keys, you too can  have  a
  30. random  Your  Sinclair  expression  inserted  in  whatever you are currently
  31. typing.
  32.  
  33.                                 INSTALLATION
  34.                                 ~~~~~~~~~~~~
  35. Even a Sinclair User reader could suss this one out, so I'm not going to say
  36. any  more,  except  that you shouldn't rename YSsim (as it will hereforth be
  37. referred to) if you want it to be able to read its tooltypes.
  38.  
  39.                                COMPATABILITY
  40.                                ~~~~~~~~~~~~~
  41. Unfortunately,  those of you who do not possess OS2.x or above won't be able
  42. to enjoy the delights of YSsim, as it's a system commodity. However, it  has
  43. to be said that  YSsim  has  undergone  absolutely  no  testing,  and  there
  44. probably  are other system set-ups under which YSsim won't work. Let me know
  45. if this is the case.
  46.  
  47.                                   STARTUP
  48.                                   ~~~~~~~
  49. YSsim  can  be  started  up  from  CLI  or  Workbench.  It  is intended as a
  50. Workbench application, however, and supports several  tooltypes.  CLI  users
  51. won't   experience  the  benefit  of  these,  and  I  couldn't  be  bothered
  52. supporting CLI arguments in this version. The supported tooltypes are ...
  53.  
  54. CX_POPKEY=<hotkey combination>
  55.    When the hotkey combination is pressed, the YSsim interface will pop  up.
  56.    This is equivalent to selecting the Show Interface button on Exchange.
  57.  
  58. CX_POPUP=YES|NO
  59.    When set to YES, YSsim's interface will pop up automatically  when  it is
  60.    started.
  61.  
  62. INSERTKEY=<hotkey combination>
  63.    This allows you to define the hotkey combination which will trigger YSsim
  64.    into action.
  65.  
  66. BACKSPACE=YES|NO
  67.    In certain  circumstances  hotkey  combinations  will  generate  unwanted
  68.    characters in a text editor. Setting the  backspace  option  to YES  will
  69.    make YSsim delete this character before typing up a message.
  70.  
  71.                                HOW TO USE IT
  72.                                ~~~~~~~~~~~~~
  73. YSsim  is  extremely easy to use. Simply press its hotkey combination (which
  74. can be defined either by a tooltype or from  the  YSsim  interface)  and  it
  75. will  "type"  a  bracketed  expression  into  the  current  position of your
  76. document. See the section Startup" for fuller details on  the  operation  of
  77. YSsim.
  78.  
  79. As YSsim is a commodity, it can  be  fully  controlled  by  the  Commodities
  80. Exchange  utility.  It  has  an  interface  which  can be used to define its
  81. hotkeys and can be terminated either by  the  quit  option  from  the  YSsim
  82. interface  or  the  Remove  option  from  the  Exchange  window.  YSsim  can
  83. similarly be activated or deactivated from the Exchange window.
  84.  
  85. If  you're wondering how you can change the expressions which YSsim inserts,
  86. you can't. This was a conscious decision in order to ensure it retains  that
  87. YS  authenticity. Oh ... don't think about using a utility such as NewZap to
  88. alter the words directly, as I've put a checksum in YSsim.
  89.  
  90.                         FUTURE PLANS AND LIMITATIONS
  91.                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92. YSsim was programmed in Acid Software's wonderful Blitz Basic 2 and uses its
  93. BRexx commands to produce its output. This is fairly slow, but that aside it
  94. does  the  job  competently  enough. At the moment, although I would like to
  95. speed it up (so that it operates as quickly  as  PowerSnap)  an  improvement
  96. isn't on the cards.
  97.  
  98. The  "backspace"  facility  (see  Startup)  is a bit of a workaround. I have
  99. seen  commodities  which  don't  have  these problems when their hotkeys are
  100. pressed,  but I have no idea how this is achieved. However, it's not a major
  101. problem (is it?).
  102.  
  103. Here's what I am planning to do in future versions of YSsim ...
  104.  
  105.    · Add support for CLI arguments
  106.    · Add a "save config" option to the interface
  107.    · Include more expressions in the YSsim database
  108.    · Include random bracket selection from () and []  brackets.
  109.  
  110.                                  DISCLAIMER
  111.                                  ~~~~~~~~~~
  112. The author (Alan Gibson) is happy that YSsim is stable in everyday  use  and
  113. will accept no  responsibility  for  any damage or loss of data which arises
  114. due to use of YSsim. In other words, you use YSsim AT YOUR OWN RISK!
  115.  
  116. This  program  is  FREEWARE,  and as such can be distributed freely provided
  117. that none  of  the  files  supplied  are  altered  (with  the  exception  of
  118. archiving)  and  that no money is charged for it, other than a small fee for
  119. distribution media and postage.
  120.